home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 August: Tool Chest / Dev.CD Aug 98 TC.toast / Tool Chest / Testing & Debugging / Virtual User / Virtual User Current Release / Examples / External Tool Templates / C Tool Template / VUAE.h next >
Encoding:
C/C++ Source or Header  |  1998-06-04  |  2.6 KB  |  77 lines  |  [TEXT/MPS ]
  1. /*
  2.  *    File:        VUAE.h
  3.  *
  4.  *    Contains:    This file is part of the Virtual User 2.0 external tool interface.
  5.  *
  6.  *    Written by:    Automation Systems, Apple Computer, Inc.
  7.  *
  8.  *    Copyright:    © 1992 by Apple Computer, Inc., all rights reserved.
  9.  *
  10.  *    Change History (most recent first):
  11.  *
  12.  *         <9>    11/18/92    CMW        Add event id and wait amount parameter for dealing with
  13.  *                                    timeouts. Removed unused parameter consts for GetToolVers.
  14.  *         <7>    11/13/92    RV        
  15.  *        <6+>    11/13/92    RV        
  16.  *         <6>    11/12/92    CMW        Change occurances of "GetToolVers" to "GetToolVersion". Rename
  17.  *                                    all constants starting with kAEVU to start with kVUAE.
  18.  *         <5>     11/2/92    RV        Added Initialize string constant
  19.  *        <4+>     11/2/92    RV        Add "Initialize" string constant
  20.  *        <2+>     5/29/92    CMW        Change all occurances of "Command" to "Service" in the names of
  21.  *                                    all the constants and events.
  22.  *        <1+>     3/11/92    CMW        Update to reflect the changes to the External Tool calls for
  23.  *                                    2.0d3
  24.  *         <1>     2/20/92    JCC        
  25.  *         <4>     2/19/92    JCC        Finishing touches
  26.  *        <3+>     2/19/92    JCC        
  27.  *         <3>     2/13/92    JCC        Rewriting the pascal commands in C
  28.  *        <2+>     2/13/92    JCC        Rewriting the pascal commands in C
  29.  *         <2>     2/13/92    CMW        Add 'errAENoErr' to errors enumeration, convert #define'd
  30.  *                                    constants to 'const's, and fix the font.
  31.  *
  32.  *    To Do:
  33. */
  34.  
  35.  
  36. #ifndef __VUAE__
  37. #define __VUAE__
  38.  
  39. #ifndef __TYPES__
  40. #include <Types.h>
  41. #endif
  42.  
  43. #ifndef __APPLEEVENTS__
  44. #include <AppleEvents.h>
  45. #endif
  46.  
  47. /* Standard constants used for communicating with VU External Tools */
  48. const long kVUAETool            = 'v.u.';    /* event class for V.U. 2.0 external tool interface */
  49. const long kVUAESendService        = 'extc';    /* event id for SendToolService */
  50. const long kVUAEWaitLonger        = 'extw';    /* event id for WaitLongerForService */
  51.  
  52. const long kVUAESrvcName        = keyDirectObject;    /* Service name for external tool Service */
  53. const long kVUAESrvcParameters    = 'extp';
  54. const long kVUAESrvcResults        = 'extr';
  55. const long kVUAESrvcTarget        = 'targ';
  56. const long kVUAEWaitAmount        = 'xtwa';
  57.         
  58.  
  59. /* Errors specific to the VU External Tool Interface*/
  60. enum VUAEErrors
  61. {
  62.     errAENoErr = 0,
  63.     errAENeverReturnThisErrorCode = 1,    /* Never EVER return this number as an error code!!! */
  64.     errAEValueTooSmall = 2,
  65.     errAEWrongParameters = 3,            /* incorrect parameters passed to external tool */
  66.     errAEUnknownService = 4
  67. };
  68.  
  69. const char* kVUAEInitialize        = "Initialize";
  70. const char* kVUAECancelService    = "Cancel";
  71. const char* kVUAEGetToolVersion    = "GetToolVersion";
  72. const char* kVUAEGetServiceList    = "GetToolServices";
  73. const char* kVUAEHasService        = "ServiceSupported";
  74. const char* kVUAEQuitService    = "Quit";
  75.  
  76. #endif
  77.